﻿/*

 * Copyright (c) 2013 Diorge Brognara, Renan Peixoto

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

*/


namespace Grafos {
    /// <summary>
    /// Especialização de Aresta, representa uma aresta de um grafo ponderado
    /// </summary>
    /// <remarks>
    /// Não há distinção direta as extremidades
    /// Implementações dessa classe podem criar a distinção para arestas direcionadas (dígrafos)
    /// </remarks>
    /// <seealso cref="ArestaPonderada"/>
    /// <example>
    /// Criação de uma nova aresta:
    /// <code>
    /// ArestaPonderada a = new ArestaPonderaad(v1, v2, 5);
    /// v1.Vizinhança.Contains(v2); // retorna true
    /// </code>
    /// </example>
    public class ArestaPonderada : Aresta {

        /// <summary>
        /// Função W da aresta
        /// </summary>
        /// <remarks>
        /// O valor indicado sempre é o mesmo que o da propriedade Valor
        /// Os diferentes nomes somente facilitam o entendimento de determinados algoritmos
        /// O valor padrão é zero (0f)
        /// </remarks>
        /// <example>
        /// <code>
        /// aresta.W == aresta.Valor; // sempre retorna true
        /// ArestaPonderada a = new ArestaPonderada(v1, v2); // não indica o valor
        /// a.W == 0; // retorna true
        /// </code>
        /// </example>
        /// <seealso cref="Valor"/>
        public float W { get; set; }
        /// <summary>
        /// Função de valor de uma aresta
        /// </summary>
        /// <remarks>
        /// O valor indicado sempre é o mesmo que o da propriedade W
        /// Os diferentes nomes somente facilitam o entendimento de determinados algoritmos
        /// </remarks>
        /// <example>
        /// <code>
        /// aresta.W == aresta.Valor; // sempre retorna true
        /// ArestaPonderada a = new ArestaPonderada(v1, v2); // não indica o valor
        /// a.Valor == 0; // retorna true
        /// </code>
        /// </example>
        /// <seealso cref="W"/>
        public float Valor { get { return W; } set { W = value; } }

        /// <summary>
        /// Instancia uma nova aresta ponderada, sem nome e sem valor, a partir de dois vértices
        /// </summary>
        /// <param name="v1">Uma das extremidades da nova aresta</param>
        /// <param name="v2">Uma das extremidades da nova aresta</param>
        public ArestaPonderada(Vértice v1, Vértice v2) : base(v1, v2) { }

        /// <summary>
        /// Instancia uma nova aresta ponderada, com nome mas sem valor, a partir de dois vérticse
        /// </summary>
        /// <param name="nome">Nome da aresta</param>
        /// <param name="v1">Uma das extremidades da nova aresta</param>
        /// <param name="v2">Uma das extremidades da nova aresta</param>
        public ArestaPonderada(string nome, Vértice v1, Vértice v2) : base(nome, v1, v2) { }

        /// <summary>
        /// Instancia uma nova aresta, sem nome mas com valor, a partir de dois vértices
        /// </summary>
        /// <param name="v1">Uma das extremidades da nova aresta</param>
        /// <param name="v2">Uma das extremidades da nova aresta</param>
        /// <param name="w">Valor de peso da aresta</param>
        public ArestaPonderada(Vértice v1, Vértice v2, float w)
            : base(v1, v2) {
            Valor = w;
        }

        /// <summary>
        /// Instancia uma nova aresta ponderada, com nome e valor, a partir de dois vértices
        /// </summary>
        /// <param name="nome">Nome da aresta</param>
        /// <param name="v1">Uma das extremidades da nova aresta</param>
        /// <param name="v2">Uma das extremidades da nova aresta</param>
        /// <param name="w">Valor de peso da aresta</param>
        public ArestaPonderada(string nome, Vértice v1, Vértice v2, float w)
            : base(nome, v1, v2) {
            Valor = w;
        }

    }
}
